/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.erossi.pigest.model.utente;

import java.util.HashSet;
import java.util.Set;

import org.erossi.common.model.GenericBean;
import org.erossi.common.util.AppCtx;
import org.erossi.pigest.model.ruolo.Ruolo;

/**
 * 'Utente' class: bean che rappresenta l'entità utente
 *
 * @author erossi
 * @version Oct 28, 2007
 */
public class Utente extends GenericBean {

  private static final long serialVersionUID = 1L;

  private String username;
  private String password;
  private Boolean enabled;
  private Set<Ruolo> ruoli;
  
  /**
   * Crea una nuova istanza della classe
   */
  public Utente() {
    
    username = null;
    password = null;
    enabled = null;
    ruoli = new HashSet<Ruolo>();
    
  }
  
  /**
   * Aggiunge un ruolo all'insieme dei ruoli
   *   cui questo utente é associato.
   *   
   * @param ruolo ruolo da aggiungere all'elenco
   */
  public void aggiungiRuolo(Ruolo ruolo) {
    
    ruoli.add(ruolo);
    ruolo.getUtenti().add(this);
    
  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti.
   * 
   * <p>
   *   Nel confronto vengono verificati gli attributi significativi del bean
   *   {@link org.erossi.pigest.model.utente.Utente}, ovvero sono esclusi quelli che 
   *   appartengono al bean generico {@link org.erossi.common.model.GenericBean}
   *   che il primo estende.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * <p>
   *   L'uguaglianza verificata é quindi quella <b>semantica</b>.
   * </p>
   * 
   * @param o l'oggetto di cui verificare l'uguaglianza
   */
  public boolean equals (Object o) {

    if (o == null) return false;
    if (!(o instanceof Utente)) return false;
    if (this == o) return true;  
    
    boolean equals = false;
    
    Utente u = (Utente) o;
    
    if (super.nullSafeEquals(u.getUsername(), this.getUsername())) {
      if (super.nullSafeEquals(u.getPassword(), this.getPassword())) {
        if (super.nullSafeEquals(u.getEnabled(), this.getEnabled())) {
          equals = true;
        }
      }
    }
    
    return equals;
    
  }
  
  /**
   * Calcola l'hash per l'oggetto corrente.
   * 
   * <p>
   *   L'hash dell'oggetto é calcolato come somma degli hash dei suoi attributi,
   *   esclusi quelli che appartengono al bean generico 
   *   {@link org.erossi.common.model.GenericBean}.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * 
   * @return l'hash corrispondente all'oggetto corrente
   */
  public int hashCode() {
    
    int hashCode = 0;
    
    if(this.getUsername() != null) {hashCode += this.getUsername().hashCode();}
    if(this.getPassword() != null) {hashCode += this.getPassword().hashCode();}
    if(this.getEnabled() != null) {hashCode += this.getEnabled().hashCode();}
    
    return hashCode;
   
  }
  
  /**
   * Imposta il valore dell'attributo 'ruoli'
   * 
   * <p>
   *   Il metodo non gestisce la biunivocità della relazione. Utilizzare il metodo
   *   {@link org.erossi.pigest.model.utente.Utente#aggiungiRuolo(Ruolo)},
   *   che garantisce la corretta associazione biunivoca fra le entità.
   * </p>
   * 
   * @param ruoli il valore dell'attributo 'ruoli'
   */
  public void setRuoli(Set<Ruolo> ruoli) {
    this.ruoli = ruoli;
  }
  
  /**
   * Ritorna una rappresentazione sotto forma di 
   *   stringa dell'oggetto.
   * 
   * @return una stringa che rappresenta l'oggetto
   */
  public String toString() {

    String toString = new String();
    toString = this.getClass().getName();
    
    toString += AppCtx.printDebug("super", super.toString());
    toString += AppCtx.printDebug("username", username);
    toString += AppCtx.printDebug("password", password);
    toString += AppCtx.printDebug("enabled", enabled);

    return toString;

  }

  /**
   * Restituisce il valore dell'attributo 'username'
   * @return il valore dell'attributo username
   */
  public String getUsername() {
    return this.username;
  }

  /**
   * Imposta il valore dell'attributo 'username'
   * @param username il valore dell'attributo 'username'
   */
  public void setUsername(String username) {
    this.username = username;
  }

  /**
   * Restituisce il valore dell'attributo 'password'
   * @return il valore dell'attributo password
   */
  public String getPassword() {
    return this.password;
  }

  /**
   * Imposta il valore dell'attributo 'password'
   * @param password il valore dell'attributo 'password'
   */
  public void setPassword(String password) {
    this.password = password;
  }

  /**
   * Restituisce il valore dell'attributo 'enabled'
   * @return il valore dell'attributo enabled
   */
  public Boolean getEnabled() {
    return this.enabled;
  }

  /**
   * Imposta il valore dell'attributo 'enabled'
   * @param enabled il valore dell'attributo 'enabled'
   */
  public void setEnabled(Boolean enabled) {
    this.enabled = enabled;
  }

  /**
   * Restituisce il valore dell'attributo 'ruoli'
   * @return il valore dell'attributo ruoli
   */
  public Set<Ruolo> getRuoli() {
    return this.ruoli;
  }

}

